

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>The errorPages module &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="../index.html" />
    <link rel="up" title="The http module" href="mod_pyamp_web_http.html" />
    <link rel="next" title="The server module" href="pyamp_web_http_server.html" />
    <link rel="prev" title="The http module" href="mod_pyamp_web_http.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="pyamp_web_http_server.html" title="The server module"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="mod_pyamp_web_http.html" title="The http module"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_web.html" >The web module</a> &raquo;</li>
          <li><a href="mod_pyamp_web_http.html" accesskey="U">The http module</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-pyamp.web.http.errorPages">
<span id="the-errorpages-module"></span><h1>The errorPages module<a class="headerlink" href="#module-pyamp.web.http.errorPages" title="Permalink to this headline">¶</a></h1>
<p>The errorPages class defined various error pages which are used
in the request handler to provide data in the event of specific errors.</p>
<div class="section" id="the-keys-class">
<h2>The Keys class<a class="headerlink" href="#the-keys-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-f6c5218362abb70d096b36f5679cd33b6509aaa0.png" alt="Inheritance diagram of pyamp.web.http.errorPages.Keys" usemap="#inheritance03df17086e" class="inheritance"/>
<map id="inheritance03df17086e" name="inheritance03df17086e">
<area shape="rect" href="../web.html#pyamp.web.http.constants.Keys" title="pyamp.web.http.constants.Keys" alt="" coords="5,7,229,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.web.http.errorPages.Keys">
<em class="property">class </em><tt class="descclassname">pyamp.web.http.errorPages.</tt><tt class="descname">Keys</tt><a class="headerlink" href="#pyamp.web.http.errorPages.Keys" title="Permalink to this definition">¶</a></dt>
<dd><p>The Keys class defines constants that are used as keys to
access certain dictionary values.</p>
<dl class="attribute">
<dt id="pyamp.web.http.errorPages.Keys.ErrorMessage">
<tt class="descname">ErrorMessage</tt><a class="headerlink" href="#pyamp.web.http.errorPages.Keys.ErrorMessage" title="Permalink to this definition">¶</a></dt>
<dd><p>The key for the entry containing the error message.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-htmlpage-class">
<h2>The HtmlPage class<a class="headerlink" href="#the-htmlpage-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-bab14edcbded7a2c5baeab4006c3395ce375f573.png" alt="Inheritance diagram of pyamp.web.http.errorPages.HtmlPage" usemap="#inheritance26df56b837" class="inheritance"/>
<map id="inheritance26df56b837" name="inheritance26df56b837">
<area shape="rect" href="pyamp_patterns_interfaces_requiredProperties.html#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="pyamp.patterns.interfaces.requiredProperties.RequiredProperties" alt="" coords="5,7,440,33"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.BasePage" title="pyamp.web.http.page.BasePage" alt="" coords="109,84,336,111"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.HtmlPage" title="pyamp.web.http.page.HtmlPage" alt="" coords="109,161,336,188"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.web.http.errorPages.HtmlPage">
<em class="property">class </em><tt class="descclassname">pyamp.web.http.errorPages.</tt><tt class="descname">HtmlPage</tt><a class="headerlink" href="#pyamp.web.http.errorPages.HtmlPage" title="Permalink to this definition">¶</a></dt>
<dd><p>The HtmlPage class provides a base class that returns
a page containing text/html content.</p>
<p>Check that all the required properties are defined.</p>
<dl class="attribute">
<dt id="pyamp.web.http.errorPages.HtmlPage.contentType">
<tt class="descname">contentType</tt><a class="headerlink" href="#pyamp.web.http.errorPages.HtmlPage.contentType" title="Permalink to this definition">¶</a></dt>
<dd><p>Define the content type for the HtmlPage.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-notfoundpage-class">
<h2>The NotFoundPage class<a class="headerlink" href="#the-notfoundpage-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-72c1acb3f2202ce0881dbf316140d77083574357.png" alt="Inheritance diagram of pyamp.web.http.errorPages.NotFoundPage" usemap="#inheritancecaeb1769db" class="inheritance"/>
<map id="inheritancecaeb1769db" name="inheritancecaeb1769db">
<area shape="rect" href="pyamp_patterns_interfaces_requiredProperties.html#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="pyamp.patterns.interfaces.requiredProperties.RequiredProperties" alt="" coords="5,7,440,33"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.BasePage" title="pyamp.web.http.page.BasePage" alt="" coords="109,84,336,111"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.HtmlPage" title="pyamp.web.http.page.HtmlPage" alt="" coords="109,161,336,188"/>
<area shape="rect" href="#pyamp.web.http.errorPages.NotFoundPage" title="pyamp.web.http.errorPages.NotFoundPage" alt="" coords="76,239,369,265"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.web.http.errorPages.NotFoundPage">
<em class="property">class </em><tt class="descclassname">pyamp.web.http.errorPages.</tt><tt class="descname">NotFoundPage</tt><a class="reference internal" href="../_modules/pyamp/web/http/errorPages.html#NotFoundPage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.web.http.errorPages.NotFoundPage" title="Permalink to this definition">¶</a></dt>
<dd><p>The NotFoundPage is displayed in the event that a requested page was
not found.</p>
<p>Check that all the required properties are defined.</p>
<dl class="attribute">
<dt id="pyamp.web.http.errorPages.NotFoundPage.errorCodes">
<tt class="descname">errorCodes</tt><a class="headerlink" href="#pyamp.web.http.errorPages.NotFoundPage.errorCodes" title="Permalink to this definition">¶</a></dt>
<dd><p>Define the list of error codes which will display this page.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-internalservererrorpage-class">
<h2>The InternalServerErrorPage class<a class="headerlink" href="#the-internalservererrorpage-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-ae4998f70015af68cea70945e4fd5567f53ce70a.png" alt="Inheritance diagram of pyamp.web.http.errorPages.InternalServerErrorPage" usemap="#inheritance3464638b7e" class="inheritance"/>
<map id="inheritance3464638b7e" name="inheritance3464638b7e">
<area shape="rect" href="pyamp_patterns_interfaces_requiredProperties.html#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="pyamp.patterns.interfaces.requiredProperties.RequiredProperties" alt="" coords="5,7,440,33"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.BasePage" title="pyamp.web.http.page.BasePage" alt="" coords="109,84,336,111"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.HtmlPage" title="pyamp.web.http.page.HtmlPage" alt="" coords="109,161,336,188"/>
<area shape="rect" href="#pyamp.web.http.errorPages.InternalServerErrorPage" title="pyamp.web.http.errorPages.InternalServerErrorPage" alt="" coords="47,239,399,265"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.web.http.errorPages.InternalServerErrorPage">
<em class="property">class </em><tt class="descclassname">pyamp.web.http.errorPages.</tt><tt class="descname">InternalServerErrorPage</tt><a class="reference internal" href="../_modules/pyamp/web/http/errorPages.html#InternalServerErrorPage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.web.http.errorPages.InternalServerErrorPage" title="Permalink to this definition">¶</a></dt>
<dd><p>The InternalServerErrorPage is displayed in the event that an
internal server error is encountered during processing. It provides
the ability to display the encountered error to the user.</p>
<p>Check that all the required properties are defined.</p>
<dl class="attribute">
<dt id="pyamp.web.http.errorPages.InternalServerErrorPage.errorCodes">
<tt class="descname">errorCodes</tt><a class="headerlink" href="#pyamp.web.http.errorPages.InternalServerErrorPage.errorCodes" title="Permalink to this definition">¶</a></dt>
<dd><p>Define the list of error codes which will display this page.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-statuscodes-class">
<h2>The StatusCodes class<a class="headerlink" href="#the-statuscodes-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-463ad76fedb363e18a70a8189ce73b271a946860.png" alt="Inheritance diagram of pyamp.web.http.errorPages.StatusCodes" usemap="#inheritance7db4398508" class="inheritance"/>
<map id="inheritance7db4398508" name="inheritance7db4398508">
<area shape="rect" href="../web.html#pyamp.web.http.constants.StatusCodes" title="pyamp.web.http.constants.StatusCodes" alt="" coords="5,7,283,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.web.http.errorPages.StatusCodes">
<em class="property">class </em><tt class="descclassname">pyamp.web.http.errorPages.</tt><tt class="descname">StatusCodes</tt><a class="headerlink" href="#pyamp.web.http.errorPages.StatusCodes" title="Permalink to this definition">¶</a></dt>
<dd><p>The StatusCodes class contains constants pertaining to
HTTP status codes.</p>
<dl class="attribute">
<dt id="pyamp.web.http.errorPages.StatusCodes.FileNotFound">
<tt class="descname">FileNotFound</tt><a class="headerlink" href="#pyamp.web.http.errorPages.StatusCodes.FileNotFound" title="Permalink to this definition">¶</a></dt>
<dd><p>The file not found status code.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.web.http.errorPages.StatusCodes.Found">
<tt class="descname">Found</tt><a class="headerlink" href="#pyamp.web.http.errorPages.StatusCodes.Found" title="Permalink to this definition">¶</a></dt>
<dd><p>The found status code.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.web.http.errorPages.StatusCodes.InternalServerError">
<tt class="descname">InternalServerError</tt><a class="headerlink" href="#pyamp.web.http.errorPages.StatusCodes.InternalServerError" title="Permalink to this definition">¶</a></dt>
<dd><p>The internal server error status code.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.web.http.errorPages.StatusCodes.MovedPermanently">
<tt class="descname">MovedPermanently</tt><a class="headerlink" href="#pyamp.web.http.errorPages.StatusCodes.MovedPermanently" title="Permalink to this definition">¶</a></dt>
<dd><p>The moved permanently status code.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.web.http.errorPages.StatusCodes.OK">
<tt class="descname">OK</tt><a class="headerlink" href="#pyamp.web.http.errorPages.StatusCodes.OK" title="Permalink to this definition">¶</a></dt>
<dd><p>The OK status code.</p>
</dd></dl>

</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">The errorPages module</a><ul>
<li><a class="reference internal" href="#the-keys-class">The Keys class</a></li>
<li><a class="reference internal" href="#the-htmlpage-class">The HtmlPage class</a></li>
<li><a class="reference internal" href="#the-notfoundpage-class">The NotFoundPage class</a></li>
<li><a class="reference internal" href="#the-internalservererrorpage-class">The InternalServerErrorPage class</a></li>
<li><a class="reference internal" href="#the-statuscodes-class">The StatusCodes class</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="mod_pyamp_web_http.html"
                        title="previous chapter">The http module</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="pyamp_web_http_server.html"
                        title="next chapter">The server module</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/_generated/pyamp_web_http_errorPages.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="pyamp_web_http_server.html" title="The server module"
             >next</a> |</li>
        <li class="right" >
          <a href="mod_pyamp_web_http.html" title="The http module"
             >previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_web.html" >The web module</a> &raquo;</li>
          <li><a href="mod_pyamp_web_http.html" >The http module</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>